home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / lib / c / strtol.man < prev    next >
Encoding:
Text File  |  1989-03-22  |  2.8 KB  |  70 lines
  1. ' Copyright 1989 Regents of the University of California
  2. ' Permission to use, copy, modify, and distribute this
  3. ' documentation for any purpose and without fee is hereby
  4. ' granted, provided that this notice appears in all copies.
  5. ' The University of California makes no representations about
  6. ' the suitability of this material for any purpose.  It is
  7. ' provided "as is" without express or implied warranty.
  8. ' 
  9. ' $Header: /sprite/src/lib/c/stdlib/RCS/strtol.man,v 1.1 89/01/05 17:59:48 ouster Exp $ SPRITE (Berkeley)
  10. ' 
  11. .so \*(]ltmac.sprite
  12. .HS strtol cmds
  13. .BS
  14. .SH NAME
  15. strtol, strtoul \- Convert character string to integer
  16. .SH SYNOPSIS
  17. .nf
  18. \fB#include <stdlib.h>
  19.  
  20. \fBlong int
  21. \fBstrtol(\fIstring\fR, \fIendPtr\fR, \fIbase\fR)
  22.  
  23. \fBunsigned long int
  24. \fBstrtoul(\fIstring\fR, \fIendPtr\fR, \fIbase\fR)
  25. .SH ARGUMENTS
  26. .AS "char *" endPtr
  27. .AP char *string in
  28. String containing ASCII representation of integer.
  29. .AP char **endPtr out
  30. If not \fBNULL\fR, gives address of pointer to fill in with address of
  31. first character in \fIstring\fR following integer.
  32. .AP int base in
  33. Base to use for conversion;  see below for explanation.  Must be
  34. between 0 and 36, inclusive.
  35. .BE
  36.  
  37. .SH DESCRIPTION
  38. .PP
  39. The \fBstrtol\fR and \fBstrtoul\fR procedures convert a character
  40. string to its corresponding integer representation and return the
  41. integer value.  Both procedures
  42. expect \fIstring\fR to point to a sequence of digits, optionally preceded
  43. by any amount of white space (as defined by the \fBisspace\fR procedure).
  44. \fBStrtol\fR also permits the digits to be preceded immediately by a
  45. minus sign, in which case the result is a negative integer.
  46. .PP
  47. If \fIbase\fR is between 2 and 36, inclusive, then the permissible
  48. ``digits'' of the string consist of the first \fIbase\fR characters
  49. in the set \fB0\fR through \fB9\fR and \fBa\fR through \fBz\fR
  50. (or \fBA\fR through \fBZ\fR).  The integer result will be calculated
  51. using \fIbase\fR as the radix for conversion.  If the value of \fIbase\fR
  52. is 16, then the characters \fB0x\fR or \fB0X\fR may precede the digits,
  53. following the sign if it is present.
  54. .PP
  55. If \fIbase\fR is 0, then the radix for conversion is chosen based on
  56. the initial digits of the number.  If the initial digits are \fB0x\fR
  57. or \fB0X\fR, then base 16 will be used for conversion;  otherwise if
  58. the first digit is \fB0\fR then base 8 will be used for conversion;
  59. otherwise base 10 will be used.
  60. .PP
  61. \fBStrtol\fR and \fBstrtoul\fR convert as many characters as possible
  62. from \fIstring\fR, and return in \fI*endPtr\fR the address of the first
  63. character not forming a valid portion of the number.  If no conversion
  64. could be performed (\fIstring\fR was empty, or did not point to a
  65. number in the expected form), then \fIstring\fR will be stored in
  66. \fI*endPtr\fR and zero is returned.
  67.  
  68. .SH KEYWORDS
  69. base, convert, integer, radix, string
  70.